﻿using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;

namespace SocialApi.Instagram.Entities.Methods.Tags
{
    /// <summary>
    /// Методы для работы с отметками
    /// </summary>
    public interface ITagMethods
    {
        /// <summary>
        /// Название отметки
        /// </summary>
        [JsonProperty("name")]
        string Name { get; }

        /// <summary>
        /// Получает информацию об <see cref="name"/> отметке
        /// </summary>
        /// <param name="name">Имя отметки</param>
        /// <returns>Информация об отметке</returns>
        ITagMethods Get(string name);

        /// <summary>
        /// Асинхронно получает информацию об <see cref="name"/> отметке
        /// </summary>
        /// <param name="name">Имя отметки</param>
        /// <returns>Информация об отметке</returns>
        Task<ITagMethods> GetAsync(string name);

        /// <summary>
        /// Получает список недавно отмеченных медиа
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <returns>Список недавно отмеченных медиа</returns>
        IEnumerable<IResult> Recent(string name);

        /// <summary>
        /// Получает список недавно отмеченных медиа
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <param name="minId">Возвращает медиа меньше заданого параметра</param>
        /// <param name="maxId">Возвращает медиа больше заданого параметра</param>
        /// <returns>Список недавно отмеченных медиа</returns>
        IEnumerable<IResult> Recent(string name, int minId, int maxId);

        /// <summary>
        /// Асинхронно получает список недавно отмеченных медиа
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <returns>Cписок недавно отмеченных медиа</returns>
        Task<IEnumerable<IResult>> RecentAsync(string name);

        /// <summary>
        /// Асинхронно получает список недавно отмеченных медиа
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <param name="minId">Возвращает медиа меньше заданого параметра</param>
        /// <param name="maxId">Возвращает медиа больше заданого параметра</param>
        /// <returns>Cписок недавно отмеченных медиа</returns>
        Task<IEnumerable<IResult>> RecentAsync(string name, int minId, int maxId);

        /// <summary>
        /// Поиск медия по имени
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <returns>Список медия по имени</returns>
        IEnumerable<ITagMethods> Search(string name);

        /// <summary>
        /// Асинхронный поиск медия по имени
        /// </summary>
        /// <param name="name">Имя медиа</param>
        /// <returns>Список медия по имени</returns>
        Task<IEnumerable<ITagMethods>> SearchAsync(string name);
    }
}